home *** CD-ROM | disk | FTP | other *** search
/ Cream of the Crop 12 / Cream of the Crop 12 (Part II) / Cream of the Crop 12 (Part II).iso / BBS / WRDWAR16.ZIP / WORDWAR.DOC < prev    next >
Encoding:
Text File  |  1996-02-15  |  24.5 KB  |  553 lines

  1.  
  2.                                WORD  WAR
  3.  
  4.                                   v1.6
  5.  
  6.                                    by
  7.  
  8.                               Al Lawrence
  9.  
  10.                             Sunrise-80  BBS
  11.                  (404) 256-9525 (USR v.everything 28.8)
  12.                  (404) 705-9104 (USR v.everything 28.8)
  13.                  (404) 256-9518 (Voice 9am-9:30pm EST)
  14.                     (EMAIL) al_lawre@ix.netcom.com
  15.  
  16.  
  17.                                 OVERVIEW
  18.                                 ________
  19.  
  20.  
  21.    The object of Word War is to create as many words as you can from the 15 
  22.    randomly chosen letters. Words formed may fall into 3, 4, 5, 6 or 7 letter
  23.    categories. Dictionary Included!
  24.  
  25.   
  26.  
  27.    NOTE: Most errors will be logged to a file called DFRAME.ERR which is
  28.          created in the directory you run the door from.
  29.  
  30.  
  31.  
  32.                 NON-REGISTERED   R E S T R I C T I O N S
  33.                 ----------------------------------------
  34.  
  35.                 ° No Bulletins created
  36.                 ° Games per day limited to 2
  37.                 ° Keyboard timeout value limited to 2 minutes
  38.                 ° Makeup days disabled
  39.                 ° Game time limit disabled
  40.                 ° Can not send/receive messages to/from other players
  41.  
  42.                 
  43.                 
  44.  
  45.  
  46.                               INSTALLATION
  47.                               ____________
  48.  
  49.  
  50.    Installation is fairly easy and straight-forward. The following steps and
  51.    examples should have you up and running in a very short period of time.
  52.    It is assumed that you are familiar with setting up DOORS on your system.
  53.    To this end, only examples of the configuration file and Door batch file
  54.    are described.
  55.  
  56.       1) Create a directory to hold all WORD WAR files
  57.  
  58.       2) Unzip WRDWARxx.ZIP into the the above directory
  59.  
  60.       3) Create a configuration file, with a name of your choice, or
  61.          modify the supplied WORDWAR.CFG file. A description follows:
  62.  
  63.             **                       Location of system file (See Below)
  64.             SUNRISE-80 BBS           Your BBS Name
  65.             Al                       Sysop's First nameAP
  66.  
  67.             Lawrence                 Sysop's Last Name
  68.  
  69. |-----------------------------------------------------------------------------|
  70. | READ!     1                        CommPort  \ These 2 lines are required   |
  71. | READ!     1                        Node #    / ONLY for GTUSER.BBS          |
  72. |-----------------------------------------------------------------------------|
  73.  
  74.             00000000                 Registration Number
  75.  
  76.         #   2                        Keyboard timeout value in Minutes
  77.  
  78.    !    #   2                        Maximum # of Games per day (MAX=26)
  79.                                      (Sysop gets 26 in Registered version)
  80.  
  81.         #   0                        Max # of days a caller can make up, during
  82.                                      calls in one day. 0=Disable Make-up Option
  83.                                      Maximum value = 27, Minimum value = 1
  84.  
  85.         #   N                        Automatic game reset at end of month:
  86.                                        Y = Yes enable autoreset
  87.                                        N = Keep accumulating scores
  88.  
  89.     !   #   0                        Time Allowed in Door
  90.                                      (Sysop = Time Remaining - REG. VERSION)
  91.  
  92.  
  93.             1                        1 = DO NOT Display ADOPT-A-DOOR Message
  94.                                      2 = Display ADOPT-A-DOOR message
  95.  
  96.         #   NONE                     Drive:\Path\Filename to contain the
  97.                                      Top Score Bulletin or enter NONE
  98.                                      for NO Bulletin creation.
  99.  
  100.         #   NONE                     Drive:\Path\Filename to contain the
  101.                                      Top Score Bulletin (Color) or enter NONE
  102.                                      for NO Bulletin creation.
  103.  
  104.         #   NONE                     Drive:\Path\Filename to contain the
  105.                                      Hall of Fame Bulletin or enter NONE
  106.                                      for NO Bulletin creation.
  107.  
  108.         #   NONE                     Drive:\Path\Filename to contain the
  109.                                      Hall of Fame Bulletin (Color) or enter NONE
  110.                                      for NO Bulletin creation.
  111.  
  112.         #   Y                        Y = Allow Sysop to have 26 games
  113.                                      N = Do Not Allow Sysop 26 games
  114.  
  115.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  116.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  117.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  118.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  119.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  120.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  121.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  122.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  123.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  124.     !   #   000=00/00                 Security Level/Games Allowed Per Day
  125.  
  126.     @   #   XXXX/YYYY                 Blackout Range  From/To
  127.     @   #   XXXX/YYYY                 Blackout Range  From/To
  128.     @   #   XXXX/YYYY                 Blackout Range  From/To
  129.     @   #   XXXX/YYYY                 Blackout Range  From/To
  130.     @   #   XXXX/YYYY                 Blackout Range  From/To
  131.  
  132.             000                       Unique 3-digit number used as a suffix
  133.                                       for the exported score file name, if
  134.                                       you wish to paricipate in an Inter-BBS
  135.                                       game. 000=no Inter-BBS participation.
  136.  
  137.             N                         Y = Force Caller to respond to
  138.                                           Instructions <y/n). May need this with
  139.                                           Digiboards.
  140.                                       N = Allow caller to press ENTER in
  141.                                           response to Instructions <y/N>
  142.  
  143.             0                         Use this option to LIMIT the number of
  144.                                       HIGH SCORE entries to be displayed. A
  145.                                       ZERO(0) = NO LIMIT
  146.  
  147.             0                         Number of months to keep in the SUNHOF
  148.                                       files (Hall of Fame). 0 = ALL
  149.  
  150.             N                         Y = Use Alias for Caller's name
  151.                                           (Requires Door.Sys)
  152.                                       N = Use Logon Name for Caller's name
  153.  
  154.             Y                         Y = Allow players to send messages to 
  155.                                           other players. Messages are contained
  156.                                           within the Door itself!
  157.                                       N = Do NOT allow messages to be sent
  158.  
  159.           ** = Replace with ONE of the following:
  160.  
  161. C:\bbs\PCBOARD.SYS              <- For PCBoard systems using PCBOARD.SYS only
  162. C:\BBS\CALLINFO.BBS             <- For Wildcat! systems (prior to v3.0)
  163. C:\BBS\DOOR.SYS                 <- For ANY systems that support DOOR.SYS
  164. C:\BBS\DORINFOx.DEF             <- For ANY systems that support DORINFOx.DEF
  165. C:\BBS\SFDOORS.DAT              <- For Spitfire systems.
  166. c:\bbs\TRIBBS.SYS               <- For TriBBS systems.
  167. C:\BBS\GTUSER.BBS               <- For GT Power
  168.                                    * if using this option you must put the
  169.                                      ComPort # on line 5 and the Node # on
  170.                                      line 6 of the configuration file
  171.  
  172.  
  173.            # = Requires registration to change to a different value.
  174.            ! = See "Plays Per Day/Door Time" Below
  175.            @ = See "Blackout Periods" Below
  176.  
  177.                NOTE: There are NO Blank Lines in the Config File!!
  178.  
  179.  
  180.       4) Create a batch file or modify the WORD WAR file supplied. A
  181.          description of this file follows:
  182.  
  183.             ECHO off
  184.             cd\BBS\DOORS\WORDWAR      Location of WORD WAR files
  185.             WORD WAR WORDWAR.CFG      EXE filename and CFG filename (Name
  186.                                       used in creating file in #3 above)
  187.             CD\BBS
  188.             BOARD
  189.  
  190.  
  191.        5) When running in more than one node, be sure to supply a
  192.           different configuration name for each node (or see below).
  193.  
  194.        6) If running with a Fossil-based multi-port board add
  195.            /FD to the line containing the CFG name as follows:
  196.  
  197.                      WORDWAR WORDWAR.CFG /FD
  198.  
  199.  
  200.  
  201.  
  202.                       WORD WAR DICTIONARY
  203.                       -------------------
  204.  
  205. Please be advised that we are aware that the dictionary is NOT all inclusive.
  206. We realize that there may be (and probably are) words that are not included.
  207. If you, or your callers, find missing words, then please forward them to the
  208. author and he will ensure that they are added (provided the word appears in
  209. the dictionary we use. A new version of the dictionary will be made available
  210. on the support board as well as being included in subsequent WORD WAR versions.
  211.  
  212.  
  213.  
  214.  
  215.                MAKE-UP DAYS (Registered version only)
  216.                --------------------------------------
  217.  
  218. The Make-Up-Day feature allows the caller to make up any plays he/she missed
  219. during the current month and prior to the current call. You control whether
  220. to allow this option, as well as the number of days the caller can make up, on
  221. any prticular days worth of calls. Entering a 0 (zero) for this option, in the
  222. configuration file, turns the option OFF, any other value (up to a max of 27)
  223. turns the option ON and dictates the number of days the caller can make up.
  224.  
  225.  
  226. NOTE:      The number of games per day is calculated as follows...
  227.  
  228.            Games Allowed per day x Number of makeup days.
  229.  
  230. Example:   Games Allowed per day = 2
  231.            Max # of makeup days  = 4
  232.  
  233. If a caller logs in on 5/8/92 and this is their first call of the month, they
  234. would have a potential of 16 games to makeup and bring them current
  235. (8 days (5/8/92) * 2 (games per day)). However, since the maximum # of Makeup
  236. Days is set at 4, the maximum # of games the caller can play on 5/8/92, is 8
  237. (games allowed * max # of makeup days).
  238.  
  239.  
  240.  
  241.              HALL OF FAME BULLETINS (Registered version only)
  242.              ------------------------------------------------
  243.  
  244. The program will automatically reset the game when the first caller of the
  245. month plays the game. The score file will be cleared and a set of Hall of Fame
  246. files will be created. The files will be called SUNHOF.ASC and SUNHOF.ANS 
  247. (ASCII and ANSI versions). The files will be placed in the same directory as 
  248. the WORDWAR.EXE file. 
  249.  
  250. WARNING: The HOF files are cumulative files. That means they are read in each
  251.          month and updated. DO NOT DELETE EITHER FILE!!!! or you will lose
  252.          the record of prior months winners!!!!
  253.  
  254.  
  255.  
  256.                           BLACKOUT PERIODS
  257.                           ________________
  258.  
  259.       Use the Blackout ranges option to define up to 5 time periods during
  260.       which you DO NOT want the Door to be played. If a caller tries to access
  261.       the Door during the Blackout period, they will be shown a message that
  262.       contains ALL the Blackout periods you have defined, and to try the Door
  263.       at a later time.
  264.  
  265.       Each of the 5 Blackout ranges takes the form of XXXX/YYYY, where
  266.       XXXX=beginning time and YYYY=the ending time. For example, 0930/1230
  267.       means to NOT allow the Door to be played between 9:30am and 12:30pm.
  268.  
  269.       IMPORTANT: - All times must be 4 digits & must follow the XXXX/YYYY format
  270.                  - DO NOT change the XXXX/YYYY entry UNLESS you want to assign
  271.                    a Blackout range.
  272.                  - You MUST use the MILITARY time format. Example: 2030=8:30pm
  273.                    0900=9am, 0030=12:30am, 1700=5pm, etc.
  274.  
  275.  
  276.                           PLAYS Per DAY/DOOR Time
  277.                           _______________________
  278.  
  279.       Plays Per Day and Door Time can be controlled several ways:
  280.  
  281.       (1) You can use the Games Per Day, singular option, in the config
  282.           file above. This option, will affect ALL callers whose Security
  283.           Level is NOT defined in any of the 10 optional Security Level/
  284.           Plays Per Day entries in the config file.
  285.  
  286.       (2) You can use the Door Time, singular option, in the config file
  287.           above. This option, will affect ALL callers whose Security
  288.           Level is NOT defined in any of the 10 optional Security Level/
  289.           Plays Per Day/Door Time entries in the config file.
  290.  
  291.       (3) You can restrict the number of games a specific Security Level
  292.           will be allowed to play per day or REWARD specific Levels with
  293.           more Plays Per Day.
  294.  
  295.           Likewise, you can restrict the Play time for a specific Security
  296.           Level or REWARD specific Levels with more Door Time.
  297.  
  298.           These options are handled by the use of the 10 config
  299.           entries (000=00/00).
  300.  
  301.           The format of each entry is as follows:
  302.  
  303.           XXX=YY/ZZ  where XXX is the Security Level (must be 3 digits)
  304.                      where =  is a constant and MUST be included
  305.                      where YY is the # of games per day (must be 2 digits)
  306.                      where / is a constant and MUST be included
  307.                      where ZZ is num. minutes per Door entry (must be 2 digits)
  308.  
  309.           If the callers Security Level is NOT defined, his/her Plays Per
  310.           Day and Door Time will be controlled by the values in items
  311.           (1) and (2), above, respectively..
  312.  
  313.           You may define up to 10 Security Levels. All unused entries must
  314.           be defined as   00=00/00
  315.         --------------------------------------------------------------------
  316.           Example: Suppose you had 3 Security Levels defined on your BBS as
  317.           (20=Subscriber, 30=Visiting Sysop, 40=CoSysop, 90=Friend) and you
  318.           wanted to set Plays Per Day as :     Subscriber=5
  319.                                            Visiting Sysop=2
  320.                                                   CoSysop=3
  321.                                                    Friend=10
  322.  
  323.           and Door Time as follows:     Subscriber=30 minutes
  324.                                     Visiting Sysop=20 minutes
  325.                                            CoSysop=10 minutes
  326.                                             Friend=remaining call time
  327.  
  328.  
  329.           You would set the Individual "Games per Day" config entry to 1 and
  330.           the individual "Door Time" to 5 minutes (these would be the
  331.           default number of games and default Time for all Security Levels
  332.           other than 20,30 or 40... make them any number you want). Next you
  333.           would replace 4 of the Security Level entries as :  020=05/30
  334.                                                               030=02/20
  335.                                                               040=03/10
  336.                                                               090=10/0
  337.  
  338.  
  339.  
  340.  
  341.                         INTER-BBS OPTION
  342.                         ----------------
  343.  
  344. The Inter-BBS option is used when you are looking for a way to expand the
  345. Triangle Solitaire competition beyond just running it on your BBS alone.
  346. With this option you can join with any number of other BBS' to create
  347. some very 'heated' scoring competition and exchange messages.
  348.  
  349. The Inter-BBS option has its own High Score file and when High Scores are
  350. displayed, on participating BBS', the name of the BBS on which the score was
  351. obtained will also be displayed. At the end of the month, the Inter-BBS
  352. scores will be reset automatically and a winner will be determined and
  353. displayed as part of the High Score display in the next month.
  354.  
  355. This option requires that the Door be registered.
  356.  
  357. The InterBBS files (EXE, HIS, DOC, etc) can be found the included file called
  358. IBBSxx.ZIP (xx = version). Updates to this file will always be found on the
  359. SUNRISE-80 BBS and many other BBS'.
  360.  
  361.  
  362. The Inter-BBS option uses the 'HUB' and 'NODE' concept. The 'HUB' is the
  363. central/controlling BBS to whom all the other BBS' ('NODES') upload/transfer
  364. their score files. The 'HUB' then merges all score files and makes a merged
  365. file available for the 'NODES' to download/transfer.
  366.  
  367.  
  368.  
  369.                         NON-STANDARD COM SUPPORT
  370.                         ________________________
  371.  
  372.       Support for COM 1-4 on the standard IRQ's - COM1/COM3 = IRQ4 and
  373.       COM2/COM4 = IRQ3. If you wish to use a non-standard IRQ, add the IRQ
  374.       number after the configuration filename. Let's assume your Door is
  375.       called FOOBAR and you want to use COM1 and IRQ5. The command line
  376.       passed to your Door would be:
  377.  
  378.                             FOOBAR FOOBAR.CFG /5
  379.  
  380.       The /5 tells FOOBAR to use IRQ5 rather than the standard IRQ4 that is
  381.       normally used with COM1. No /x parameter is needed for the standard
  382.       IRQ's.
  383.  
  384.       As an alternative, you may use an environmental variable on the command
  385.       line. To use the variable (following the example above), place a
  386.       SET IRQ=5 in the batch file used to bring up your BBS (you would need a
  387.       different IRQ number for each node). The command line would now look
  388.       like this:
  389.  
  390.                           FOOBAR FOOBAR.CFG /%IRQ%
  391.  
  392.       This, in combination with the use of the environmental variables
  393.       described in the MULTI-NODE SETUP section will allow you to use one
  394.       batch file and one config file to run this door on all nodes.
  395.  
  396.  
  397.  
  398.  
  399.                            MULTI-NODE SETUP
  400.                            ________________
  401.  
  402.       All Sunrise Doors are Multi-Node capable. Each node must have the
  403.       ability to access a configuration file which will have its own system
  404.       file (DORINFOx.DEF, PCBOARD.SYS, DOOR.SYS, etc) defined on the first
  405.       line. There are 2 ways to accomplish this:
  406.  
  407.       (1) Create a separate configuration file for each node. The only
  408.           difference between each file would be the location of the system
  409.           file for that particular node. For example, on my system there are 2
  410.           nodes and the first line of the config files would look like this:
  411.  
  412.                         NODE1:  H:\PCB1\DOOR.SYS
  413.                         NODE2:  H:\PCB2\DOOR.SYS
  414.  
  415.           Thus, if you have a 4 node BBS, you will need 4 configuration files.
  416.  
  417.       (2) Use ONE configuration file for ALL nodes. This Door will recognize
  418.           the following PCBoard/Wildcat environmental variables:
  419.  
  420.                  PCBDIR    (Directory containing the System file)
  421.                  PCBDRIVE  (Drive containing the System file)
  422.                  WCNODEID  (Active Node Number)
  423.  
  424.           Thus, the first line of the SINGLE configuration file, for this Door
  425.           would look like this:
  426.  
  427.                         %PCBDRIVE%%PCBDIR%\DOOR.SYS
  428.                         c:\wc30\wcwork\node%wcnodeid%\door.sys
  429.  
  430.       NOTE: This option, as described, assumes that you are running PCB or
  431.             Wildcat software. The environmental variables are automatically
  432.             created by the software for each node.
  433.  
  434.             HOWEVER, if you are running other BBS software you should be able
  435.             to set the variables EXACTLY as described below, for EACH node
  436.             (more than likely in each batch file you use to bring up EACH node):
  437.  
  438.                             PCBDRIVE=C:
  439.                             ^^^^^^^^^
  440.                             PCBDIR=\NODE2
  441.                             ^^^^^^^^
  442.  
  443.             Info with a carat (^) under it, MUST be typed as is. The rest
  444.             depends on your naming conventions.
  445.  
  446.             This, in combination with the use of the optional environmental
  447.             variable described in the NON-STANDARD COM SUPPORT section, will
  448.             allow you to use one batch file and one config file to run this
  449.             door on all nodes.
  450.  
  451.  
  452.                                ADOPT-A-DOOR
  453.                                ____________
  454.  
  455.     Having been a Sysop for a number of years, I have had my share of problems
  456.     and frustrations getting financial support for my board's upkeep. A fellow
  457.     Sysop left a message on my board, not long ago, about a concept that was
  458.     being used by several boards around the country.
  459.  
  460.     The concept, ADOPT-A-DOOR, allows a caller to register (ADOPT) a door. It
  461.     would be the same as sending in a donation, only this way it is earmarked
  462.     for registering a particular door. In a way, the user feels he/she is
  463.     "getting something in return". As a Door author I have decided to build
  464.     this concept into each of my Door programs. The concept replaces the
  465.     usual message "tell the Sysop to register this Door" we find in most
  466.     doors.
  467.  
  468.     If the Door is unregisterd then a message appears on the opening screen
  469.     to that effect. After finishing or suspending a game, a message screen
  470.     is displayed about the ADOPT-A-DOOR concept. The message also tells the
  471.     caller to contact the Sysop to find out if there is any further details
  472.     to the ADOPT-A-DOOR concept. Some Sysops give extra D/L time, online
  473.     time, etc to callers that ADOPT-A-DOOR.
  474.  
  475.     If the Door has been registered, either by the Sysop or other callers,
  476.     the names of those contributors will be displayed in the closing screen.
  477.  
  478.     NOTE: If you want to display the names of the callers that contributed
  479.           to registering the Door, you must create an ASCII file called
  480.           ADOPT.SYS. You create it with an Editor or Word Processor. Enter
  481.           the name(s) of the contributors (one on each line, maximum of 5
  482.           entries, each a maximum of 30 characters long). This file must be
  483.           saved, in ASCII format, and placed in the Door directory.
  484.  
  485.  
  486.  
  487.                               LEGALITIES
  488.                               __________
  489.  
  490.  
  491.       THIS SOFTWARE AND ACCOMPANYING MATERIALS ARE DISTRIBUTED "AS IS"
  492.       WITHOUT WARRANTY, EXPRESS, IMPLIED OR STATUTORY, INCLUDING BUT NOT
  493.       LIMITED TO ANY IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS
  494.       FOR A PARTICULAR PURPOSE. IN NO EVENT SHALL ANYONE INVOLVED WITH
  495.       THE CREATION AND PRODUCTION OF THIS PRODUCT BE LIABLE FOR INDIRECT,
  496.       SPECIAL, OR CONSEQUENTIAL DAMAGES, ARISING OUT OF ANY USE THEREOF
  497.       OR BREACH OF ANY WARRANTY.
  498.  
  499.  
  500.  
  501.  
  502.  
  503.                              DISTRIBUTION
  504.                              ____________
  505.  
  506.    You may make this file available for downloading from your BBS or you may
  507.    upload it to any BBS of your choice, provided that you do not make any
  508.    changes to the contents of the archive (ZIP file). The archive and its
  509.    individual contents may not be used by any service that charges any money
  510.    whatsoever, without the written permission of the author.
  511.  
  512.  
  513.  
  514.  
  515.  
  516.                              REGISTRATION
  517.                              ____________
  518.  
  519.    Registration and the subsequent insertion of the registration number into
  520.    your configuation file, allows for the display of your BBS name on the
  521.    opening and closing screen as well as the reduction of a delay built into
  522.    the opening screen display along with the ability to change certain
  523.    values in the configuration file.
  524.  
  525.    To register your copy of WORD WAR, please fill out the registration form
  526.    (REGISTER.FRM) and mail it along with the registration fee to
  527.    the name and address on the form.
  528.  
  529.    Once a door is registered, any changes to registration information (Sysop
  530.    name or BBS Name) will require the doors to be re-registered at the
  531.    registration fee in effect at that time.
  532.  
  533.    Be sure to use the proper upper/lower case when filling in your name and
  534.    BBS name, as they MUST match the way you entered them in the configuration
  535.    file.             ^^^^
  536.  
  537.    Based upon information supplied on the registration form, I will pre-
  538.    register you on my BBS. You will then be able to call SUNRISE-80 and pick
  539.    up your registration number.
  540.  
  541.  
  542.  
  543.                                  MISC
  544.                                  ____
  545.  
  546.    The latest version of WORD WAR and other fine SUNRISE DOOR programs are
  547.    always available for download from SUNRISE-80 BBS.
  548.  
  549.    Remember, should you have any problems, questions or suggestions, be sure
  550.    to drop me a message on either of the aforementioned BBS', SmartNet (Sysops)
  551.    Rime (PCBhints, Common, Doors, Sysops) or FidoNet 1:133/410
  552.  
  553.